home *** CD-ROM | disk | FTP | other *** search
/ Personal Computer World 2005 October / PCWOCT05.iso / Software / FromTheMag / XAMPP 1.4.14 / xampp-win32-1.4.14-installer.exe / xampp / php / pear / docs / PhpDocumentor / Release-1.2.2 < prev    next >
Text File  |  2004-03-24  |  19KB  |  411 lines
  1. $Id: Release-1.2.2,v 1.1.2.21 2003/08/19 16:14:31 CelloG Exp $
  2.  
  3. PhpDocumentor Version 1.2.2
  4. ################################################################################
  5. http://www.phpdoc.org
  6. Joshua Eichorn jeichorn@phpdoc.org
  7. Gregory Beaver cellog@users.sourceforge.net
  8. ################################################################################
  9. ################################################################################
  10.  
  11. The phpDocumentor team would like to announce the release of phpDocumentor
  12. 1.2.2.  This is a bugfix maintenance release.  The biggest change is to the
  13. DocBook/peardoc2, CHM and PDF converters.  All three have advanced from beta
  14. to stable and are ready for production use in generating multiple documentation
  15. formats.  The PDF Converter now uses color syntax highlighting for all source
  16. code!
  17.  
  18. WARNING: in order to install phpDocumentor using pear, you MUST apply the
  19. patch publicweb-PEAR-1.2.1.patch.txt to the core of PEAR 1.2.1 (not phpDocumentor,
  20. PEAR, to be absolutely clear).  After applying the patch, install with
  21. this command:
  22.  
  23. pear install /path/to/PhpDocumentor-1.2.2/package.xml
  24.  
  25. you MUST use this command if you plan to use the web interface:
  26.  
  27. pear config-set publicweb_dir /path/to/public_html/pear
  28.  
  29. where /path/to/public_html/pear is a subdirectory of a webserver.  With this
  30. patch, if the document root is /path/to/public_html, then you can browse to
  31. the web interface simply by opening http://localhost/pear/PhpDocumentor/
  32.  
  33. Several critical bugs were discovered in the implementation of HighlightParser,
  34. post-processing of tutorials.  In addition, the algorithm used to find file-level
  35. documentation was changed to be more natural.  All users should upgrade existing
  36. installations to 1.2.2
  37.  
  38. Note that the license of phpDocumentor 1.2.2 is different from phpDocumentor 1.1.0.
  39. phpDocumentor 1.2.2 is under the PHP License version 3.0, full text is in
  40. PHPLICENSE.txt
  41.  
  42. for PEAR programmers, the new --pear command-line switch will be a boon.  Leave
  43. it on by default if your package follows PEAR coding and directory naming standards
  44.  
  45. ------
  46. IMPORTANT: phpDocumentor 1.2.2 requires PHP version 4.1.0 or greater.
  47. phpDocumentor will function best with PHP version 4.3.0 or greater, as it will
  48. use of the tokenizer extension if php 4.3.0 is installed for a tremendous
  49. increase in parsing speed.
  50. ------
  51.  
  52. Speaking of speed, do NOT run the PDF Converter with --sourcecode = on for any
  53. medium to large sized projects.  I had to kill a PDF generation after 36 hours
  54. on a Pentium IV 2.66GHz computer - 36 hours!  The design of the PDF generation
  55. library is tremendously inefficient, probably on the order of O(n^2).  I'd fix
  56. this if I knew anything about PDF.  If there are any users out there with the
  57. time and expertise to look into the algorithms used by CPdf, we would all
  58. appreciate it.
  59.  
  60. phpDocumentor is a JavaDoc-like automatic documentation generator for PHP
  61. written in PHP.  It is the most versatile tool for documenting PHP.
  62.  
  63. Once again, phpDocumentor brings a great increase in usability with the 1.2
  64. branch.  The addition of a tokenizer-based parser increases parsing speed by
  65. up to 4 times (that's 400% faster) compared to previous versions.  In addition,
  66. scalability has been improved, allowing generation of documents in multiple
  67. output formats with one command.  The usage of config files makes repetitive
  68. parsing tasks straightforward and reduces the chance for error.
  69.  
  70. The addition of DocBlock templates, extended documentation (tutorials) parsing,
  71. and many other new features make this release the most useful automatic
  72. documentor for any programming language.
  73.  
  74. The default HTML Converter has been ported to a new Smarty-based converter,
  75. HTMLframesConverter, and all of the old templates have been ported to the new
  76. Smarty-based format.  The HTMLdefaultConverter has been deprecated since its
  77. functionality is redundant.  Due to the time it takes to convert a template to
  78. the new format, the phpDocumentor team extends an offer to do this conversion
  79. for anyone who has a brand new template.  We may also include the template in a
  80. future release, if permission is granted.
  81.  
  82. Due to interest from PEAR programmers, there is a new beta-quality XML:DocBook
  83. converter with peardoc2 templates.  This converter could also generate other
  84. DocBook formats, if desired, but does not generate indexing for this release.
  85.  
  86. The PDF Converter has stepped up to beta-quality, is fully templatable, and
  87. has most bugs completely fixed.  The CHM converter has also taken major strides
  88. and is beta quality.
  89.  
  90. As predicted, the Smarty template engine is the primary template engine for
  91. all converters.
  92.  
  93. For users new to phpDocumentor, phpDocumentor uses an event-driven parser
  94. and intermediary data structures that allow it to perform at a level other
  95. automatic documentors for PHP cannot achieve:
  96.   --parsing any php file, with multiple classes and functions in the same file
  97.   --fully compliant with even the most esoteric php syntax 
  98.       ($string = <<< EOF, for example)
  99.   --ability to generate multiple output formats
  100.   --extremely fast parsing
  101.   --error/warnings by line number and file to allow for debugging of
  102.     documentation tags
  103.   --multiple output templates to easily customize the look of generated
  104.     documentation
  105.   --extensive documentation of the package, including a detailed specification
  106.     for tags and the included template engine
  107.   --open source, GPL
  108.   
  109.  
  110. A full listing of all closed bugs and feature requests can be found in the 
  111. next section of the notes
  112.  
  113. phpDocumentor 1.2.2 ready for production use documenting any PHP project,
  114. download it and try the most advanced solution for PHP documentation
  115. today.
  116.  
  117. ################################################################################
  118.  
  119. The following bugs are fixed in version 1.2.2
  120.  [ 765455 ] phpdoc can't find php if it is in /usr/local/bin
  121.  [ 767251 ] broken links when no files in default package
  122.  [ 768947 ] Multiple vars not recognised
  123.  [ 772441 ] nested arrays fail parser
  124.  [ 778920 ] tutorial link warning
  125.  [ 779552 ] "Documention" instead of "Documentation" in generated pages
  126.  [ 780332 ] {@link} is closing the link prematurely when a ',' is found
  127.  [ 781913 ] usedby not when @uses at class level
  128.  [ 784810 ] stat failing.
  129.  [ 786180 ] simple lists fail if line starts with an inline tag
  130.  [ 788251 ] {@link function blah()} and {@link object blah} fail
  131.  [ 788271 ] HighlightParser links to methods before classes
  132.  [ 790685 ] HighlightParser doesn't link class::method() outside methods
  133.  [ 791023 ] bug in output: <br; />
  134.  [ 791030 ] old PHP version bug /t and ' becomes to "
  135.  [ 791131 ] old PHP version bug in output, if define contains "("
  136.  [ 791291 ] ignoretags handling incorrectly looks for ignore-tags
  137.  
  138. The following bugs are fixed in version 1.2.1
  139.  [ 731750 ] Links to unparsed includes shown (reopened)
  140.  [ 735134 ] HTML:Smarty:default Documentation can not be printed
  141.  [ 749446 ] php-cli.exe has been renamed in the PHP 4.3.x distribution
  142.  [ 749841 ] The links do not work in errors.html. Page has no achors.
  143.  [ 750264 ] @ignore won't work with DocBlock Templates /**#@+
  144.  [ 750392 ] Formatting doesn't work in Templates /**#@+
  145.  [ 751066 ] Return type of a constructor is not void.
  146.  [ 751101 ] output error when optional parameters are in use
  147.  [ 752015 ] Docbuilder problems
  148.  [ 752040 ] phpDocumentor 1.2.0 can't parse itself in php < 4.3.0
  149.  [ 753278 ] @see parent::_privatefunc causes endless loop
  150.  [ 753641 ] phpdoc -h output
  151.  [ 755681 ] include error in docbuilder file_dialog.php
  152.  [ 755688 ] lost image(s)
  153.  [ 756730 ] preview image for HTML:Smarty not found
  154.  [ 757841 ] JavaScript-Error cause of Package-Name
  155.  [ 758387 ] Use of undefined constants in DocBlockTags.inc on line 830
  156.  [ 764412 ] Complex class inheritance/package causes endless loop
  157.  [ 765753 ] Extraneous trailing "-" in @uses when no description
  158.  [ 765765 ] docbuilder can't change ini dir
  159.  
  160. The following bugs are fixed in version 1.2.0
  161.  [ 729841 ] Source code only for certain file if same name used
  162.  [ 730081 ] --ignore-tags docs unclear
  163.  [ 730214 ] weird filesource
  164.  [ 731560 ] docbuilder include error on linux
  165.  [ 731750 ] Links to unparsed includes shown
  166.  [ 732900 ] ordered list messes up
  167.  [ 733100 ] phpdoc's help output shows 2 times option "quiet"
  168.  [ 733352 ] optional description parameter in @license tag
  169.  [ 732642 ] DocBook support broken/incomplete.
  170.  [ 735697 ] the web interface
  171.  [ 736832 ] Fatal error in phpDocumentorTParser.inc
  172.  [ 739740 ] Page-level docs are not generated without a @package tag
  173.  [ 740859 ] @uses in docblock template crashes parser
  174.  [ 740871 ] crash in DocBlockTags.inc line 99
  175.  [ 741887 ] case-sensitivity bug
  176.  [ 744026 ] @uses breaks on Classes.inc
  177.  [ 744028 ] {@link $el, $notfound} returns blank text
  178.  [ 746674 ] phpedit - vars, methods
  179.  [ 746690 ] DocBlocks not parsed for require_once statements
  180.  [ 746692 ] makedoc.sh $TITLE bug
  181.  [ 747733 ] cannot use same filename + different path in @example
  182.  [ 748314 ] --pear on php4/pear uses . as dirname
  183.  [ 748837 ] @uses with spaces
  184.  [ 748850 ] {@link} documentation is unclear
  185.  
  186. The following bugs are fixed in version 1.2.0RC2
  187.  [ 708928 ] write permissions needed on some program dirs
  188.  [ 723230 ] warning on line 1391, HighlightParser
  189.  [ 723320 ] @param output behaves funny
  190.  [ 723767 ] space needed after @param type $var
  191.  [ 723947 ] RIC parsing not reading the correct README
  192.  [ 724415 ] Non-package references not always resolved
  193.  [ 724417 ] Multi-level method references not linked
  194.  [ 724701 ] conflicting package names, inherited links fails to show up
  195.  [ 724857 ] @link URL text broken
  196.  [ 725247 ] Wrong list handling in peardoc converter
  197.  [ 725745 ] HTML:Smarty:* not creating ric_README.html
  198.  [ 725161 ] File view displays class symbols without names
  199.  [ 725788 ] if --packageoutput excludes files with classes
  200.  [ 725742 ] code tag alignment
  201.  [ 726195 ] Formatting tags breaks lists
  202.  [ 726313 ] Changelog not linked
  203.  [ 727823 ] "#@+"-block quirck?
  204.  [ 728585 ] static keyword
  205.  [ 728167 ] HTML tags are case sensitive
  206.  
  207. The following bugs are fixed in version 1.2.0RC1
  208.  [ 566663 ] @param &$arg broken
  209.  [ 657041 ] {@source} doesn't work right
  210.  [ 675871 ] --pear breaks if not a pear repository
  211.  [ 678176 ] Inherited vars/methods in HTML:frames:phpedit
  212.  [ 680652 ] Optional method/function parameters
  213.  [ 681459 ] {@internal}} not quite working
  214.  [ 681463 ] {@source} drops characters
  215.  [ 681735 ] {@source} in sdesc needs warning
  216.  [ 682490 ] {@internal}} not parsed right by highlightparser
  217.  [ 682491 ] multi-line description fubared in @tag
  218.  [ 687091 ] special characters not encoded
  219.  [ 687364 ] highlightparser $class->member incorrect
  220.  [ 687403 ] {@source} leaves "}"
  221.  [ 689874 ] is_a is not avaliable in PHP 4.1.0
  222.  [ 689893 ] Warnings on PHP 4.1.0
  223.  [ 689894 ] getincludevalue() missing argument 2 warning
  224.  [ 692522 ] @uses is screwy
  225.  [ 693213 ] tutorials post-processed twice
  226.  [ 693215 ] {@internal}} on single line not working
  227.  [ 694448 ] PKZip has bug, use winzip (not phpDocumentor bug)
  228.  [ 694594 ] PEAR mode: destructor image not shown by phpedit template
  229.  [ 694742 ] PDF converter has no table of contents
  230.  [ 695291 ] link to todo disappears in HTML:Smarty:*
  231.  [ 695482 ] @uses not checking for @access private
  232.  [ 695622 ] HTML:Smarty:* has no package-level docs
  233.  [ 696883 ] <code> in description crashes parser
  234.  [ 697156 ] PHP Warning with PDF Converter
  235.  [ 697656 ] putting a <code> inside a <li> turns it into a literal
  236.  [ 698417 ] {@link element descrip} wrong
  237.  [ 697644 ] parse fails if unmatched html tag, or text outside <li> list
  238.  [ 698468 ] Fatal error when inline tag across two lines
  239.  [ 698356 ] {@internal} not working properly
  240.  [ 701199 ] extra br in @filesource generation
  241.  [ 702549 ] --quiet option not valid?
  242.  [ 705897 ] HTML:frames:earthli misses Page.gif
  243.  [ 708560 ] intelligent list handling isn't quite working
  244.  [ 708559 ] @category tag not really working
  245.  [ 710366 ] <i>-Tag is ignored
  246.  [ 710700 ] empty defaultpackagename = caused busy loop
  247.  [ 711569 ] Fatal Error: Undefined Method during write
  248.  [ 712704 ] HTML:Smarty:* drops class level author information
  249.  [ 708914 ] <var>, <samp>, <kbd> broken
  250.  [ 713201 ] variable variables are not parsed properly in @global
  251.  [ 713954 ] @param type $var when &$var broken
  252.  [ 715077 ] HighlightParser needs @tag object classname support
  253.  [ 715084 ] HighlightParser craps out after $var->
  254.  [ 715452 ] @example doesn't work with anything other than .php
  255.  [ 718253 ] Using 'parent' in @example file causes crash
  256.  
  257. The following bugs are fixed in version 1.2.0BETA3
  258.  [ 661317 ] PDF converter in subpackage ids broken
  259.  [ 669945 ] CHM: "undefined function: convert()" with multiple outputs 
  260.  [ 670205 ] inherited methods have no links
  261.  [ 670341 ] <pre> in docblock doesn't htmlentitie
  262.  [ 670350 ] left_frame.tpl missing package level doc link
  263.  [ 670440 ] Io::getBase() is buggy
  264.  [ 670903 ] inline desc <code> not <pre>-ized
  265.  [ 671620 ] warning in Parser line 2271
  266.  [ 672149 ] @desc broken
  267.  [ 674053 ] Support for require_once 
  268.  [ 674059 ] requires PHP version 4.2 or higher
  269.  [ 674075 ] Bad @param kills parser
  270.  [ 677105 ] unbalanced HTML-comments in output of HTML:frames:phpedit
  271.  [ 677821 ] define not parsed right in highlightparser
  272.  [ 677822 ] {@source} not showing whole source
  273.  [ 677826 ] nonsense @link in @see breaks HTML output
  274.  [ 677938 ] whitespace wrong after certain docblocks
  275.  
  276. The following bugs are fixed in version 1.2.0BETA2
  277.  [ 665707 ] Warnings and errors in new_phpdoc.php
  278.  [ 666307 ] whitespace not ignored in @param
  279.  [ 669132 ] "no @package tag was used" error but @ignore & @package used
  280.  [ 669525 ] {$children[kids].sdesc} contains parent sdesc
  281.  [ 669613 ] Call to undefined function: getclassleft()
  282.  [ 669615 ] methods disapper
  283.  [ 669640 ] javadocdesc broken
  284.  [ 669909 ] PDF text starts off left side of page when have package.html
  285.  
  286. The following bugs are fixed in version 1.2.0BETA1a
  287.  [ 661976 ] @see broken
  288.  [ 662630 ] {} delimited variables within strings mess up the parser
  289.  [ 663435 ] define values, global variable values need htmlentities
  290.  [ 664058 ] @param not displayed in HTMLframesConverter 
  291.  
  292. The following bugs are fixed in version 1.2.0BETA1
  293.  
  294.  [ 586357 ] ignore a directory
  295.  [ 637921 ] sorting is weird with multiple package
  296.  [ 637928 ] multiple converters legal, but fails
  297.  [ 638042 ] two declarations of checkstate()
  298.  [ 638128 ] commandline win32 fails, w/relative path
  299.  [ 639553 ] new_phpdoc.php fails with php 4.2.3
  300.  [ 640507 ] constructor links broken
  301.  [ 641076 ] second instance of loop fails
  302.  [ 641235 ] need trim of -f and -d commandline
  303.  [ 641334 ] parse <script language="php"> as <?php
  304.  [ 642427 ] Incorrect Anchor link from elementIndex
  305.  [ 645588 ] elements named "function.." or "global.." don't link
  306.  [ 646281 ] {@link mailto:e@a descrip} broken
  307.  [ 647494 ] {@link element1, element2} incorrect
  308.  [ 648684 ] links to global vars, defines in Smarty wrong
  309.  [ 649646 ] comments not parsed in function
  310.  [ 649953 ] phpdoc command-line only runs from install dir
  311.  [ 650946 ] link to phpdoc.org new window
  312.  [ 651837 ] getLink broken in rare case
  313.  [ 653627 ] @staticvar broken
  314.  [ 654429 ] tutorial prev/next links not working
  315.  [ 655372 ] smarty template not found in pdf convers
  316.  [ 657041 ] {@source} doesn't work right
  317.  [ 657387 ] parent/child tutorials converted twice
  318.  [ 657726 ] used by link htmlentitiezed
  319.  [ 657739 ] need separate categories of {@tags}
  320.  [ 657934 ] subtrees not processed in Converter
  321.  [ 658120 ] PDF define template has bug
  322.  [ 658121 ] PDF Converter not passing elements sorte
  323.  [ 661316 ] @tutorial tutorial.ext#subsection.section broken
  324.  
  325. There of course were other small bugs fixed, these were just the bugs with 
  326. entries in source forge.  You can view the bug details or reopen it if
  327. you think it's not totally fixed at:
  328. http://sourceforge.net/tracker/?group_id=11194&atid=111194
  329.  
  330. Features added that had Feature Request entries in SF for 1.2.2:
  331.  [ 776322 ] Parser cuts out on blank tags
  332.  
  333. Features added that had Feature Request entries in SF for 1.2.0:
  334.  [ 748419 ] Provide different tag variable types for template use
  335.  
  336. Features added that had Feature Request entries in SF for 1.2.0 rc 2:
  337.  [ 704808 ] command-line switch for template directory/converter directory
  338.  [ 722987 ] Relative example files
  339.  
  340. Features added that had Feature Request entries in SF for 1.2.0 rc 1:
  341.  [ 681470 ] Add syntax highlighting for <programlisting role="php"> 
  342.  [ 682810 ] Xref
  343.  [ 683101 ] starting/ending line numbers of docblocks/classes/methods
  344.  [ 687366 ] phpEdit-style list support
  345.  [ 695621 ] link to section of @filesource from each element
  346.  [ 714025 ] @license tag
  347.  
  348. Features added that had Feature Request entries in SF for 1.2.0 beta 3:
  349.  [ 674470 ] output a list of all @todos
  350.  [ 675194 ] -cp for converter-specific dynamic params 
  351.  
  352. Features added that had Feature Request entries in SF for 1.2.0 beta 2:
  353.  [ 650251 ] @filesource tag 
  354.  [ 670184 ] @example tag 
  355.  [ 670189 ] @internal/{@internal}} 
  356.  [ 670190 ] --ignore-tags command-line 
  357.  
  358. Features added that had Feature Request entries in SF for 1.2.0 beta 1a:
  359.  [ 663436 ] --title available in all pages, html
  360.  [ 663437 ] error if @package is missing 
  361.  [ 663439 ] PEAR command-line switch 
  362.  
  363. Features added that had Feature Request entries in SF for 1.2.0 beta 1:
  364.  
  365.  [ 541896 ] Create an Extended Howto
  366.  [ 558118 ] add {@inheritDoc}
  367.  [ 562604 ] Using @access blocs (_start ... _end)
  368.  [ 564991 ] auto-links to php manual
  369.  [ 566942 ] add {@link seeelement descrip}
  370.  [ 569746 ] make Program_root/ template thing
  371.  [ 577714 ] have master directory option
  372.  [ 586401 ] @access protected
  373.  [ 608603 ] REQUEST:class/function usage information
  374.  [ 615419 ] manuals like "php.net manual"
  375.  [ 623055 ] Zend IDE suport
  376.  [ 634518 ] inherit @author, @version, @copyright
  377.  [ 634589 ] @uses element
  378.  [ 634641 ] A way to document form variables
  379.  [ 635184 ] update all templates to phphtmllib
  380.  [ 637409 ] {keyword} - {data} pairs not flexible
  381.  [ 637660 ] parse type|type
  382.  [ 637920 ] simple way to extend a converter
  383.  [ 642235 ] Index of phphtmllib template
  384.  [ 645775 ] line numbers for elements
  385.  [ 651275 ] tutorials
  386.  [ 651716 ] automatically find README/INSTALL
  387.  [ 651723 ] @tutorial/{@tutorial}
  388.  [ 653608 ] allow the /user ini dir to be configable 
  389.  
  390. ################################################################################
  391.  
  392. The documentation has been updated for this release you can view it at
  393. http://phpdocu.sourceforge.net/spec/
  394. or in the distribution in the spec directory
  395.  
  396. The changelog is available in the tarball, or online at 
  397. http://phpdocu.sourceforge.net/Changelog
  398.  
  399. You can download the newest version from 
  400. http://phpdocu.sourceforge.net/downloads.php
  401.  
  402. And of course you can reach the webpage at http://phpdocu.sourceforge.net/ or 
  403. http://phpdoc.org/ 
  404.  
  405. enjoy
  406. -joshua eichorn <jeichorn@phpdoc.org>
  407. -gregory beaver <cellog@users.sourceforge.net>
  408.  
  409.  
  410. vim: set expandtab :
  411.